home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / program / pearl30.zip / PEARL.DOC < prev    next >
Text File  |  1994-01-15  |  15KB  |  414 lines
  1.  
  2.                                   PEARL V3.0
  3.  
  4.                          The Programmer's Text Editor 
  5.  
  6.  
  7.  
  8.  
  9.  
  10. 2
  11.                                  INTRODUCTION
  12.  
  13.  
  14.  
  15. Pearl is a text editor designed with programmer's in mind. Word processing 
  16. features are absent but features of use to developers are included instead 
  17. including COMPILE and RUN facilities allowing a program to be tested and 
  18. reedited without leaving Pearl. The compile facility works with ANY computer 
  19. language making Pearl useful to ALL programmers.
  20.  
  21. Pearl supports user-definable fonts generated by Servile Software's PCFONT 
  22. program. This enables Pearl to operate in any available display line mode from 
  23. 25 to 50 lines on a computer equipped with a VGA monitor. 
  24.  
  25. Pearl has been developed so that the minimum number of keys need to be pressed 
  26. to carry out any operation. 
  27.  
  28. Pearl is also very compact. Occupying only about 50K of disk space making 
  29. Pearl one of the smallest text editors on the market. 
  30.  
  31.  
  32. Specifications:
  33.  
  34. Maximum file size:      Dependant upon available conventional RAM, but usually
  35.                         about 500K bytes.
  36.  
  37. Maximum line length:    999 bytes
  38.  
  39. Maximum lines:          Unlimited
  40.  
  41. Maximum loaded macros:  10 predefined
  42.                         8  User definable
  43.  
  44. Display lines:          Dependant upon loaded font, ranges from 25 to 50
  45.                         depending upon monitor type
  46.  
  47. 3
  48.                                     STARTUP
  49.  
  50.  
  51.  
  52. Pearl is started by entering the command PEARL from the dos prompt. A name of 
  53. a file to load may also be optionaly specified forcing Pearl to load that file 
  54. for editing. 
  55.  
  56. For example. To startup Pearl and edit the file "myfile.doc", from the dos 
  57. prompt enter the command:
  58.  
  59. PEARL MYFILE.DOC
  60.  
  61. If the specified file does not exist, Pearl will warn you that the file could 
  62. not be loaded, but will retain the file's name assuming that you wish to 
  63. create it.
  64.  
  65.  
  66.  
  67. 4
  68.                                  ENTERING TEXT
  69.  
  70.  
  71.  
  72. Use the normal typewriter keys to enter text. If you enter text at the end of 
  73. a line the cursor (a flashing block) will drop down to the start of the next 
  74. line. To go down a line press the return key. The cursor may be moved around 
  75. the text with the four arrow keys. Mistakes can be deleted with the backspace 
  76. key to delete the character to the left of the cursor (usually the last 
  77. character entered). The delete key deletes the character at the cursor 
  78. position.
  79.  
  80. The case of the text may be toggled between upper and lower case by pressing 
  81. key F5. This toggles the case of alphabetical characters at the cursor 
  82. position, and moves the cursor right one character in the current line. To 
  83. force text to upper case use Shift F5. To force text to lower case use Ctrl 
  84. F5.
  85. 5
  86.                              SEARCHING & REPLACING
  87.  
  88.  
  89. Pearl supports full text search and replace functions. Press Ctrl Q F to 
  90. search for a string. Press Ctrl Q A to search for and replace a string. Press 
  91. Ctrl L to continue a search or search and replace operation.
  92.  
  93. Positioning the cursor over a left bracket character '(', '{' or '[' and 
  94. pressing F6 will cause Pearl to search for the matching right bracket 
  95. character. If a matching bracket is found, the cursor will be positioned over 
  96. it. Otherwise, a message will be displayed and the cursor will not move.
  97.  
  98. To move quickly to a known line number press Alt G and enter the desired line 
  99. number.
  100. 6
  101.                                   INDENT MODE
  102.  
  103. When Indent mode is active, pressing return goes down one line and then 
  104. inserts a number of spaces at the start of the line so that the cursor is at 
  105. the same column as the first non-space character of the previous line.
  106.  
  107. Indent mode is selected when Pearl starts. It may be toggled by pressing ALT 
  108. I. The current indent status is displayed on the status line at the top of the 
  109. screen. 
  110. 7
  111.                                   ASCII TABLE
  112.  
  113.  
  114. Pearl includes an Ascii character table so that characters not represented on 
  115. the keyboard can be easily entered into the text. Press Alt A to display the 
  116. Ascii chart, and then move the highlight block to the character you want to 
  117. insert. You may then press return to insert the highlighted character as 
  118. though it had been typed at the keyboard, or press Esc to abort the operation. 
  119. The only character which you cannot select is ascii code 10 because this is 
  120. used as a formatting character by Pearl. If you try to select this character 
  121. Pearl will simply ignore you.
  122. 8
  123.                                      MENUS
  124.  
  125.  
  126. From the edit mode, any menu may be selected by pressing Alt and the 
  127. highlighted letter key. You may switch between Edit mode and the last menu by 
  128. pressing Esc. For example. To drop-down the File menu whilst editing a file 
  129. press Alt F. To then compile the loaded file either press C, or move the 
  130. highlight bar over the word Compile and press Return.
  131. 9
  132.                                      FILES
  133.  
  134.  
  135.  
  136. To load a file quickly press F3. Pearl will respond by requesting the name of 
  137. the file to be loaded. This will be in the form of the asterisk wild card and 
  138. the default file extension described in the configuration file. You may simply 
  139. type in the name of a file to load, including an optional path. 
  140.  
  141. When you press Return on the file name, Pearl checks to see iof an asterisk 
  142. wildcard is included in the file name. If it is, Pearl builds a list of all 
  143. files matching the specification in the current directory and also all 
  144. subdirectories in the current directory. You may then select a file from the 
  145. list by highlighting it and pressing Return. Or you may change directory by 
  146. highlighting the desired directory entry (displayed in upper case) and 
  147. pressing Return. If you don't want to load any file press Esc to abort the 
  148. operation.
  149.  
  150.  
  151. To save the current file press F2. Pearl will copy the existing disk file to a 
  152. file with the same name but with the extension .BAK, and then write the file 
  153. in memory back to disk. To save the loaded file under a different name select 
  154. the 'save As' option from the Files menu.
  155. 10
  156.                                     MACROS
  157.  
  158.  
  159. What is a macro?
  160.  
  161. A macro is a combination of key strokes which may be replayed to save you time 
  162. typing them in manually.
  163.  
  164. Pearl makes use of two types of macro. Predefined macros which are simple text 
  165. strings loaded automatically when Pearl commences operation. And user 
  166. definable macros which are complex, recordable combinations of key strokes. 
  167. Predefined macros are entitled F1.MAC, F2.MAC, F3.MAC .... F10.MAC and are 
  168. loaded from the same directory as Pearl commences operation from. These macros 
  169. are executed by pressing Ctrl and the appropriate function key.
  170.  
  171. Predefined macros may be edited with a text editor (such as Pearl) with the 
  172. proviso that: a) they can not be longer than 100 characters, 
  173.               b) they can only include character codes greater than 31
  174.  
  175. Record:
  176.  
  177. Macros are best created by recording. Selecting the Record option from the 
  178. macro menu forces Pearl to record all key strokes entered EXCEPT for 
  179. verification regarding file overwrites. Pressing Alt Esc stops the recording 
  180. mode. A macro has now been recorded and should be Saved.
  181.  
  182. Save:
  183.  
  184. Save stores the recorded macro to both a text file and the first free slot on 
  185. the macro menu.
  186.  
  187. Load:
  188.  
  189. Load reads a macro from disk and stores it at the first free slot on the macro 
  190. menu. If there are no free slots, a message will be displayed and you will not 
  191. be given the option to enter a macro file name.
  192.  
  193. Playing Macros:
  194.  
  195. A macro may be replayed by selecting it from the macro menu, or pressing its 
  196. Alt Function key combination. Where Alt F1 plays back macro 1, Alt F2 plays 
  197. back macro 2 and so on up to Alt F8 which plays back macro 8.
  198.  
  199.  
  200. Editing Macros:
  201.  
  202. Macros are stored in fully editable text files. Each character/key stroke 
  203. command is separated by a white space (space, tab, or carriage return). Some 
  204. key strokes are stored in the macro file in a descriptive format as 
  205. illustrated in the following table:
  206.  
  207.  
  208. 11
  209. Macro Text  Keyboard equivalent
  210. -------------------------------
  211. [cr]        Carriage return
  212. [tab]       Tab
  213. [spc]       Space
  214. home        Home
  215. pgup        PgUp
  216. pgdn        PgDn
  217. left        Left arrow
  218. right       Right arrow
  219. up          Up arrow
  220. down        Down arrow
  221. delete      Delete
  222. bk_space    Backspace
  223. ctrl_pgdn   Ctrl PgDn
  224. ctrl_pgup   Ctrl PgUp
  225. ctrl_left   Ctrl left arrow
  226. ctrl_right  Ctrl right arrow
  227. alt_left    Alt left arrow
  228. alt_right   Alt right arrow
  229. ctrl_k      Ctrl K
  230. ctrl_l      Ctrl L
  231. ctrl_q      Ctrl Q
  232. ctrl_t      Ctrl T
  233. alt_e       Alt E
  234. alt_f       Alt F
  235. alt_m       Alt M
  236.  
  237. All other keystrokes are recorded in their native form. When a macro file is 
  238. Loaded it is compiled before being assigned to a macro slot.
  239. 12
  240.                                 QUICK REFERENCE
  241.  
  242. Cursor Navigation:
  243.  
  244. Key                 Function
  245.  
  246. Up Arrow            Up one line
  247. Down Arrow          Down one line
  248. Right Arrow         Right one character within current line
  249. Left Arrow          Left one character within current line
  250. Ctrl Right Arrow    Right one word within current line
  251. Ctrl Left Arrow     Left one word within current line
  252. Home                Start of current line
  253. End                 End of current line
  254. PgUp                Up one page
  255. PgDn                Down one page
  256. Ctrl PgUp           Start of file
  257. Ctrl PgDn           End of file
  258. Ctrl K 1,2,...9     Set marker 1,2,...9
  259. Ctrl Q 1,2,...9     Goto marker 1,2,...9
  260. Alt G               Goto line number
  261.  
  262. Deletion:
  263.  
  264. Delete              Delete character at cursor
  265. Backspace           Delete character left of cursor
  266. Ctrl Y              Delete current line
  267. Ctrl T              Delete word right
  268.  
  269. Search & Replace:
  270.  
  271. Ctrl Q F            Find text
  272. Ctrl L              Continue search for text
  273. Ctrl Q A            Find text and replace it with new text.
  274.  
  275.  
  276. Block operations:
  277.  
  278. Ctrl K B            Mark start of block
  279. Ctrl K K            Mark end of block
  280. Ctrl K C            Copy block to cursor
  281. Ctrl K V            Move block
  282. Ctrl K W            Write block to file
  283. Ctrl K Y            Delete block
  284. Alt Right Arrow     Shift block right one character
  285. Alt Left Arrow      Shift block left one character
  286.  
  287.  
  288. Macros:
  289.  
  290. Ctrl F1             Playback predefined macro 1
  291. Ctrl F2             Playback predefined macro 2
  292. Ctrl F3             Playback predefined macro 3
  293. Ctrl F4             Playback predefined macro 4
  294. 13
  295. Ctrl F5             Playback predefined macro 5
  296. Ctrl F6             Playback predefined macro 6
  297. Ctrl F7             Playback predefined macro 7
  298. Ctrl F8             Playback predefined macro 8
  299. Ctrl F9             Playback predefined macro 9
  300. Ctrl F10            Playback predefined macro 10
  301. Alt F1              Playback macro 1
  302. Alt F2              Playback macro 2
  303. Alt F3              Playback macro 3
  304. Alt F4              Playback macro 4
  305. Alt F5              Playback macro 5
  306. Alt F6              Playback macro 6
  307. Alt F7              Playback macro 7
  308. Alt F8              Playback macro 8
  309. Alt Esc             Stop macro recording
  310.  
  311.  
  312. Other Keys:
  313.  
  314. Insert              Toggle insert/over type mode
  315. Alt A               Ascii Chart
  316. Alt E               Edit
  317. Alt F               File menu
  318. ALT I               Toggle indent mode
  319. Alt X               Leave Pearl
  320. Esc                 Edit mode->Menu->Edit mode toggle
  321. Tab                 Insert spaces to next tab position
  322. F2                  Save Current file
  323. F3                  Load New File
  324. F4                  Convert tabs to spaces
  325. F5                  Toggle current character case
  326. Shift F5            Switch current character to upper case
  327. Ctrl F5             Switch current character to lower case
  328. F6                  Locate matching right bracket/brace/parenthesis
  329. 14
  330.                               CONFIGURATION FILE
  331.  
  332.  
  333. Pearl makes use of a configuration file. This file, entitled "pearl.cfg" 
  334. contains information about screen length, colours, line length and tab size. 
  335. All parameters in the file are optional, defaults being used if they are not 
  336. found. The configuration file is comprised of separate lines starting with the 
  337. parameter followed by its value. Pearl loads this configuration file from the 
  338. directory where pearl.exe resides.
  339.  
  340. Variable                Function
  341.  
  342. font                    Load a user definable font
  343. display                 Edit display attribute
  344. highlight               Highlight display attribute
  345. menu text               Menu text display attribute
  346. menu highlight          Menu text highlight attribute
  347. menu first letter       Menu first letter display attribute
  348. status text             Status text/ascii table display attribute
  349. tab size                Tab size (expanded to spaces)
  350. line length             Maximum line length in characters
  351. compiler                Name and parameters for compiler
  352.  
  353. For example:
  354.  
  355. Pearl Configuration file
  356.  
  357. font                    std12.fnt
  358. display                 14
  359. highlight               30
  360. menu text               23
  361. menu highlight          94
  362. menu first letter       19
  363. status text             7
  364. tab size                4
  365. line length             100
  366. compiler                tcc -ms -N- -v- -y-
  367.  
  368. Unrecognised text is ignored, as is the case of the text.
  369. 15
  370.                               COMPILING & RUNNING
  371.  
  372.  
  373.  
  374. Pearl allows a compiler to be named in the configuration file which can be 
  375. used to compile the currently loaded file. Any compiler parameters are 
  376. included in the configuration file along with the compiler's program name. 
  377. When the compile option is selected from the file menu, Pearl issues the 
  378. command <compiler> <fname> where <compiler> is the 'compiler' text from the 
  379. configuration file, and <fname> is the name of the current text file loaded 
  380. into pearl. After the compiler terminates, Pearl displays a message and waits 
  381. for a key to be pressed so that you can see any warnings or errors reported by 
  382. the compiler.
  383.  
  384. A program with the same name as the loaded file, such as a compiled version, 
  385. may be run with the run option from the file menu. After the program 
  386. terminates Pearl resumes operation immediately. 
  387. 16
  388. Pearl is distributed as Shareware. You are free to use this product for a 
  389. period not exceeding 30 days from when you obtained it. After that you must 
  390. either register it or stop using it.
  391.  
  392. Registration of Pearl is accomplished by sending a cheque or money order for 
  393. 19.95 pounds sterling, made payable to M. Probert to Servile Software, 
  394. 5 Longcroft Close, Basingstoke, Hampshire, RG21 1XG, England. 
  395.  
  396. Registered users are entitled to:
  397.  
  398.         * Free life-time telephone support
  399.         * Free upgrade to the latest version
  400.         * Full Turbo C & assembler source code 
  401.         * Use Pearl past 30 days
  402.  
  403.  
  404. Written by:     Matthew Probert
  405.  
  406. Published by:   Servile Software
  407.                 5 Longcroft Close
  408.                 Basingstoke
  409.                 Hampshire
  410.                 RG21 1XG
  411.  
  412. Telephone:      0256 478576
  413.  
  414.